docs: add mip as the recommended way to install chunkIE - #194
Merged
Conversation
Adds an 'Install with mip (recommended)' section to the top of the Get chunkIE page, documenting installation via the mip package manager (https://mip.sh).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds an Install with mip (recommended) section to the top of the Get chunkIE documentation page, documenting installation via the mip package manager for MATLAB.
mip installs chunkIE together with its dependencies using pre-built MEX binaries, so users don't have to compile anything themselves — this sidesteps the fmm2d/mex compilation issues described further down the page. chunkie is registered in mip's core channel, so
mip install chunkieworks out of the box.The existing "Installation From Source", "Precompiled Windows Binaries", and "Troubleshooting" sections are unchanged and follow the new mip section.